Skip to content

Update README for current CLI behavior and troubleshooting#35

Merged
ncode merged 1 commit intomainfrom
docs/update-readme-troubleshooting
Feb 13, 2026
Merged

Update README for current CLI behavior and troubleshooting#35
ncode merged 1 commit intomainfrom
docs/update-readme-troubleshooting

Conversation

@ncode
Copy link
Owner

@ncode ncode commented Feb 13, 2026

This pull request updates the README.md to clarify TagIt's functionality, provide more detailed usage instructions, and add new sections for configuration, development, and troubleshooting. The documentation now better explains how TagIt manages Consul service tags, how to configure it, and how to resolve common issues.

Clarification of TagIt functionality:

  • Rewrote the project description to clarify that TagIt replaces managed tags matching the tag-prefix and preserves non-prefixed tags, instead of simply appending script output.

Expanded usage and examples:

  • Updated all example commands to use modern shell conventions and more realistic script paths, and expanded the examples to include script creation, service registration, running TagIt, generating a systemd file, and cleaning up tags. [1] [2] [3]

Configuration details:

  • Added a new Configuration section describing CLI flags, config file support, and environment variable binding, including an example YAML config.

Development workflow:

  • Introduced a Development section with Makefile targets for building, testing, and running integration tests with Docker Compose.

Troubleshooting guidance:

  • Added a comprehensive Troubleshooting section covering common errors, systemd command requirements, quick checks for Consul and service status, and validation steps for cleanup.

New table of contents entries:

  • Updated the table of contents to include the new Configuration, Development, and Troubleshooting sections.

@codecov
Copy link

codecov bot commented Feb 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.94%. Comparing base (8a12db7) to head (8dc3d0b).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #35   +/-   ##
=======================================
  Coverage   89.94%   89.94%           
=======================================
  Files           8        8           
  Lines         368      368           
=======================================
  Hits          331      331           
  Misses         25       25           
  Partials       12       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ncode ncode merged commit 9a7fd75 into main Feb 13, 2026
8 checks passed
@ncode ncode deleted the docs/update-readme-troubleshooting branch February 13, 2026 02:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant